-
Notifications
You must be signed in to change notification settings - Fork 551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: highlight the use of machine name for orgs help #326
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know that machine-name is really clear; perhaps post an example alongside it, or clarify that it's the "machine name not the humanised name"?
@robcresswell agree about the example, I had the same feeling. Question is how would we refer to that name if not by "machine name" ? |
I think filling out the text with an example should be enough. More bothered about clarity than pretty help output :) |
@robcresswell how does it read now? |
15766b2
to
c9f03f8
Compare
08a23e3
to
7181063
Compare
🎉 This PR is included in version 1.136.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What does this PR do?
Current help advises to use specify the org name but it isn't clear about the fact that you need to specify the "machine name" representation of the org name.
If I have an org called "Liran demo", it has a machine name of "liran-demo-123" associated with it and the latter is the one that should be provided to the CLI.